; * lisp/help-fns.el (help-fns-function-name): Doc fix.
authorEli Zaretskii <eliz@gnu.org>
Fri, 22 Mar 2024 07:54:37 +0000 (09:54 +0200)
committerEli Zaretskii <eliz@gnu.org>
Fri, 22 Mar 2024 07:54:37 +0000 (09:54 +0200)
lisp/help-fns.el

index 422f6e9dddf938175deb066b7f901d6191f89aca..638af81ded813761e39a92db6765c181565bd9f7 100644 (file)
@@ -2465,7 +2465,14 @@ one of them returns non-nil."
 
 ;;;###autoload
 (defun help-fns-function-name (function)
-  "Return a short string representing FUNCTION."
+  "Return a short buttonized string representing FUNCTION.
+The string is propertized with a button; clicking on that
+provides further details about FUNCTION.
+FUNCTION can be a function, a built-in, a keyboard macro,
+or a compile function.
+This function is intended to be used to display various
+callable symbols in buffers in a way that allows the user
+to find out more details about the symbols."
   ;; FIXME: For kmacros, should we print the key-sequence?
   (cond
    ((symbolp function)